/*===========================================================================
  Copyright (C) 2014 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  This library is free software; you can redistribute it and/or modify it 
  under the terms of the GNU Lesser General Public License as published by 
  the Free Software Foundation; either version 2.1 of the License, or (at 
  your option) any later version.

  This library is distributed in the hope that it will be useful, but 
  WITHOUT ANY WARRANTY; without even the implied warranty of 
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 
  General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License 
  along with this library; if not, write to the Free Software Foundation, 
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  See also the full LGPL text here: http://www.gnu.org/copyleft/lesser.html
===========================================================================*/

package net.sf.okapi.v2.common.om;

/**
 * Represents a group or a unit in a file. 
 */
public interface IGroupOrUnit extends IWithAnnotations {

	/**
	 * Indicates if this item is a {@link ITextUnit} object or a {@link IGroup} object.
	 * @return true if this item is a {@link ITextUnit} object, false if it is a {@link IGroup}.
	 */
	public boolean isUnit ();
	
	/**
	 * Gets the id of this object.
	 * @return the id of the object.
	 */
	public String getId ();
	
	/**
	 * Gets the type of this unit.
	 * @return the type of this unit (can be null).
	 */
	public String getType ();
	
	/**
	 * sets the type of this unit.
	 * @param type the type of this unit (can be null).
	 */
	public void setType (String type);
	
	/**
	 * Gets the name of this unit.
	 * @return the name of this unit (can be null).
	 */
	public String getName ();
	
	/**
	 * Sets the name of this unit.
	 * @param name the name of this unit (can be null).
	 */
	public void setName (String name);

}
